home *** CD-ROM | disk | FTP | other *** search
/ .net (French) 1996 November / .net Magazine (FR) - Issue 01 - Nov 1996.iso / mac / Outils / Compression ⁄ Encodage / UUTool-FAT / UUTool-FAT.rsrc / TEXT_129.txt < prev    next >
Text File  |  1995-06-17  |  13KB  |  160 lines

  1. UUTool 2.4
  2. By Bernie Wieser ┬⌐ 1990 to 1995
  3. Octavian Micro Development Inc.
  4. ALL RIGHTS RESERVED
  5.  
  6. Contents
  7. 1.0 Licensing Agreement
  8. 2.0 File Menu Features
  9.   2.1 UUcode
  10.   2.2 Text Segmentation
  11.   2.3 Finding Files' Creator and Type
  12.   2.4 Audio Files
  13.   2.5 Preferences
  14. 3.0 Revisions Log
  15. 4.0 Trouble Shooting
  16.   4.1 XXcode
  17. 5.0 How to Contact Me
  18.   Credits
  19.  
  20.  
  21. 1.0    Licensing Agreement
  22.     Octavian Micro Development hereby releases UUTool, a program for encoding and decoding UUENCODED format files, as 'freeware' on the following conditions.  The user understands that UUTool is the property of Octavian Micro Development, and that Octavian Micro Development is not responsible for any damages incurred through the use of said tool.  UUTool is not for commercial use without prior registration with Octavian Micro Development.  UUTool must not be sold, or distributed on/in any media for profit (including mail order) without the prior consent of Octavian Micro Development.  Use or distribution of said tool implies this agreement is understood and abided by.
  23.      The coding engine in UUTool is available for licensing.  Please contact me for more details.  If you would like to support UUTool's development, please send a donation to the address below.
  24.  
  25. 2.1    UUcode
  26.      The UUcode menu item from the File menu offers an implementation 'uuencode' and 'uudecode' binary to text file utilities for the MacintoshΓäó.  The purpose is to translate binary files into text for transmission over some electronic medium (i.e. electronic mail, usenet news, etc.).  It is compatible with many UNIXΓäó implementations, with extra coding to support the two file fork MacintoshΓäó architecture.
  27.      UUTool currently supports multiple file decode on openning of the UUTool application only.  From the Finder, select your target text files and select Open from the file menu, or drag the selected icons onto the UUTool icon.
  28.  
  29. 2.2 Text Segmentation
  30.      The Segment menu item allows for the multiple splitting and joining of text files.  The join L├ª available from the Segmentation preferences allows you to change headers for decoded file name, segment number, and start and end cut lines.  These exist in a queue and their weighting is determined by the queue element number (which you cannot change in 2.3).  All split input files are pre-scanned before joining.  Name and parts are guessed at until a cut line is reached.  Then all the parts which seem contiguous are concatenated into an output file.
  31.      Split will split text files by size or by number of lines.  Header information is included in both cut lines which are inserted before and after the segmented text.  Splitting is a two stage process.  The source text file is split into its parts.  Then the parts are opened to make their header information textual.
  32.      UUTool only understands the checksum its own headers.  This checksum is the result of adding all the text characters in the segment of the source file, not including the headers.  (Checksum is not implemented in 2.3)
  33.      Join is a slow process.  It also is not fool-proof.  You might have to use a text editor to join the parts anyway.
  34.  
  35. 2.3 Finding Files' Creator and Type
  36.      The Show Creator and Type menu item allows you to easily hunt down the creator and types of files.  Select a target file with the standard file dialog to see it's creator and type.  If the file is a document, click the Find Creator button to show the file types supported by the creator application.
  37.      Known bugs include confusion on machines with multiple desktop files with Find Creator.
  38.  
  39. 2.4 Audio Files
  40.      UUTool supports the translation of 8 bit audio files to AIFF or MacintoshΓäó linear format, as well as AIFF to ULAW or linear audio files.  Sampling rate is maintained when using AIFF format.  If the AIFF file is corrupt, then use linear format instead and set your sampling rate to 7 kHz with whatever sound program you're using for playback.
  41.  
  42. 2.5    Preferences
  43.      There are three options currently under the preferences menu:  Segmentation, UUcode, and Save Prefs.  Save Prefs. will save all preference settings.
  44.  
  45. 2.5.1 Segmentation preferences
  46.      The Segmentation preferences currently support splitting a file by line count or by size.  Optionally you can add a checksum.
  47.      Know your host's text limits.  AppleLink has a 32K limit.  CompuServe has a 50K limit.
  48.      The Join DB button gets you to the header database.  There are four fields for file name, part numer, and cut begin and end lines.  These lines are compared with lines in the source file.  There are four join variables to be set.  Each variable begins with a 'Γêé' symbol.  Γêéchksm allows you to denote where an 8 character hexadecimal checksum of the segmented data.  Γêéfile allows you to denote where the original file name would be.  Γêépart and Γêétotal allow you to denote which part of how many in the segment you are working on.  In addition, the 'ΓǪ' character means 'accept all input until I match the character following ΓǪ'  The '┬¼' character means match a carriage return.  The 'Use It' check box denotes whether or not you want that header record to be used in the search.
  49.      Examples:
  50.           "Subject: Γêéfile ΓǪ[Γêépart/Γêétotal"  is valid
  51.           "Subect:ΓǪΓêéfile" is invalid, since the character after ΓǪ is Γêé
  52.  
  53. 2.5.2 UUcode preferences
  54. MacintoshΓäó Preferences
  55.      By default MacintoshΓäó files are encoded in their entirety.  UUTool's decode can see MacintoshΓäó formatted files and restore them to their original condition.  The data fork of a file is the first part in the encoded text file, bounded by a 'begin' and 'end' statement.  This is followed by the resource fork, and finally finder information (i.e. the file's icon, etc.)  When the check box for data fork only is on, only the data fork of a file is encoded or decoded.  Either way, on a UNIXΓäó system only the data fork will be decoded.
  56.      The "use original coding" check box will use the standard uu**coding method, necessary for many PC implementations.  I suggest not using original coding when using UNIXΓäó machines, since some electronic mailors reformat white space.
  57.     The PC, UNIXΓäó, and MacintoshΓäó radio buttons allow for different ways of encoding a file's name.  The PC button on means the name will be truncated to eight characters, an extension,  and no special characters will be used.  The UNIXΓäó button on means no special characters will be used.  The MacintoshΓäó button on means anything goes!  Be careful about characters in file names.  The PC and UNIXΓäó buttons will replace dangerous character (like '/' and '\') with underscores.  Extended characters will be replaced by the hash symbol ('#').
  58.      Default creator and file type are only used if UUTool does not find Finder information, or can't guess at it.  With the SetType check box on, UUTool will scan through the SetType signature database and try find a match.
  59.  
  60. UNIX Preferences
  61.      UNIXΓäó permission defines the file's permission modes if the file is to be decoded on a UNIXΓäó machine.  For example, '0700' stands for read/write/execute for owner only.  This is ignored on the Mac side.
  62.  
  63.      You can put whatever text you like before the first 'begin' statement or after the last 'end' statement (except those tokens must start on a new-line!)  UUTool should be able to decode files with headers.  Try not to fiddle with information between those tokens.
  64.  
  65. SetTypes
  66.      You can specify UUTool's guess for a file's creator and type with the SetType button.  This involves knowing something about the internal structure of your decoded files.  Most reasonable programers have their data files identify themselves with a static signature somewhere in the file.  If you provide a signature of less than 9 bytes, and an offset, UUTool will set the suggested creator and type of the decoded output file if there is a match.   I recommend using a disk editor to obtain this information.
  67.  
  68. 3.0    Revision Log
  69. v1.1 - fixed drawing into a NIL window brought about by file errors.
  70. v1.2 - fixed SysBeep problem under finder (not having enough memory to be loaded back in).
  71. v1.2.2 - fixed some port problems
  72. v1.2.3 - fixed an addressing problem for 68000 machines
  73. v2.0b - stream i/o completely removed with faster new engine (UENG)
  74. - added encode/decode status (allowed with new engine)
  75. - no longer uses all memory but works with 110K
  76. - no longer supports CR/LF encoding (CR only)
  77. v2.0b1 - corrected dialogue problem under system 7.0
  78. - added app. file open support
  79. 2.0.1 - added 'mstr' support
  80. - added keyboard shortcuts to prefs. as well as their feedback
  81. - uses UENG 1.0.1 which allows for variable buffers (still uses old sizes)
  82. - removed debug traps in UENG
  83. - all code is 32 bit clean and 68000 compatible (I hope :-)
  84. 2.0.2 - fixed ignore EOF in uudecode UENG
  85. - added user abort to encode/decode
  86. 2.0.3 - uses UENG 1.0.3, nicer abort
  87. 2.0.4 - added original coding option
  88. 2.0.5 - moved most strings into resources for localization purposes
  89. 2.0.6 - added on-line documentation and print
  90. - changed GetNextEvents to WaitNextEvents (no WNE check though)
  91. - added some EventAvails (so now background tasks get time)
  92. 2.0.7 - converted to Think C 5.0.2 by Bob Abeles
  93. 2.0.8 - slightly optimized uu-engine 1.0.4
  94. - supports balloon help
  95. 2.0.9 - fast new begin scan
  96. - work around system 7.0 SetFPos bugs (uu-engine 1.0.5)
  97. 2.0.10 - support for audio files
  98. 2.1 - removed Balloon help, Split, and other unused things
  99. - added file error catching to sound stuff
  100. - changed UNIXΓäó encoding table to ignore {,}
  101. - more optimized and bug fix uu-engine 1.0.6
  102. 2.1.1 - another bug fix to the uu-engine 1.0.7
  103. - bug fixes regarding error messages
  104. 2.1.2 - fixed bug regarding PC file name's length
  105. - added Show Creator/Type and GuessType support
  106. - changed decode to only decode data fork if "data fork only" option is set
  107. 2.1.2.1 - fixed decoded file name bug
  108. 2.1.2.1 - fixed a DIV0 on the status bar when encoding an empty file
  109. 2.2 - unloaded Scrap to fix memory problems
  110. - added Split support
  111. - moved SetType configuration to UUcoding prefereces
  112. - rearranged all the menues
  113. - added Gestalt calls to check system config. and fixed error messages
  114. 2.2.1 - changed encoding file name to use one of three formats, and changed decoding to take everything to EOL (end of line).
  115. 2.3 - added multiple decode files
  116. - released join beta
  117. 2.3.1 - hmmmmΓǪ  can't attach an invisible list to a NIL port; try the window manager's
  118. - so,Scrappy, I unloaded 'u 'case 'u gave me trouble, now you're zero'd
  119. 2.3.2 - fixed a bug to be system 6 compat. in SFGetFiles
  120. 2.3.3 - updated and re-compiled everything
  121. 2.3.4 - fixed the decode problem
  122. - added a flushvol
  123. - moved prefs. from data fork to resource fork
  124. 2.4 - accelerated for Power Macintosh!
  125. - supports core apple events
  126. - sped up split and join
  127. - updated Balloon help
  128.  
  129.  
  130. 4.0    Trouble Shooting
  131.      ΓÇó If you get a -108 error, allocate UUTool more memory from the Finder.   This error is usually associated with insufficient application memory for the clipboard.
  132.      ΓÇó Don't run UUTool from a locked disk, or have the application software locked.
  133.      ΓÇó the Find creator feature only works for the boot desk-top DB.
  134.  
  135.      If you don't like the UUcoding translate tables I provide with UUTool, you can change them.  They exist in HEXA resources 128 and 129.
  136.  
  137. 4.1 XXCode
  138.      This program is a uu**coder, not an xx**coder.  XX is a strain of uu**code which allows users of computers which use EBCDIC character coding (mainly IBM mainframes) to translate binary files into text files and visa versa.  I have modified my UNIX translate table to not use the '{' or '}' characters, but the '^' character presents a bit of a problem.  '^' should become '~' for xx**coding.  Until such time as someone funds me to implement an xx**coder, you can use a text editor and globally replace '^' with '~' and it should work.  UUTool will NOT decode these files properly!
  139.  
  140.      If you find any bugs or have any comments, feel free to write me a letter (address below.)
  141.  
  142. 5.0     How to Contact Me
  143.      Octavian Micro Development is a software/hardware development company.  I (Bernie) wrote UUTool in 1990 when I was an undergrad, but I am a real software engineer now and know how to write real Macintosh applications.  Version 2.4 is the last version of UUTool, so enjoy it.  You can buy the source code for $50 US.
  144.  
  145.   My address is:
  146.      Octavian Micro Development Inc.
  147.      4115 Brisebois Drive N.W.
  148.      Calgary, Ab., Canada
  149.      T2L-2E8
  150.  
  151.   Office Phone # (403)289-5986
  152.   e-mail Octavian.bsw@eworld.com
  153.  
  154. Credits:
  155.  
  156. I'd like to thank everyone who has sent me positive comments.  And to those who sent negative comments, bite me, its free.
  157.  
  158. MacintoshΓäó is a registered trademark of Apple Computer Inc.
  159. UNIX is a registered trademark of AT&T Information Systems.
  160.